home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d2 / tlb_v117.arc / HIGHUMM.DOC < prev    next >
Text File  |  1990-12-21  |  22KB  |  662 lines
  1.  
  2.  
  3.         
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.                                    HIGHUMM.SYS
  12.  
  13.  
  14.                Application Program Interface (API) to Upper Memory
  15.  
  16.  
  17.  
  18.  
  19.                                   Version 1.17
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.                                Copyright (C) 1990
  28.                                All Rights Reserved
  29.  
  30.  
  31.  
  32.  
  33.                                        by
  34.  
  35.  
  36.                               KEY SOFTWARE PRODUCTS
  37.                                 440 Ninth Avenue
  38.                           Menlo Park, California 94025
  39.                                  (415) 364-9847
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.                          Prodigy E-Mail Address: VGDC59A
  54.                E-Mail on Internet, Bitnet, etc: DLEWIS@SCU.BITNET
  55.              CompuServe E-Mail Address: >Internet:DLEWIS@SCU.BITNET
  56.  
  57.  
  58.  
  59.  
  60.         
  61.  
  62.  
  63.         Dec 04, 1990      HIGHUMM.SYS API Specification                 1
  64.  
  65.  
  66.         HIGHUMM.SYS  is a device driver that lets application programmers
  67.         access  upper  memory  between  640k  and 1Meg.  It requires that
  68.         LASTBYTE  be  installed first.  HIGHUMM may itself be loaded into
  69.         upper memory with HIGHDRVR.  
  70.  
  71.         HIGHUMM provides two methods of accessing high memory: 
  72.  
  73.         _1_.__X_M_S__U_p_p_e_r__M_e_m_o_r_y__B_l_o_c_k_s_____ 
  74.  
  75.         If  an  Extended  Memory  Specification  (XMS)  driver  (such  as
  76.         HIMEM.SYS)  has  already  been loaded, HIGHUMM will link into it,
  77.         providing   an  implementation  of  the  two  XMS  functions  for
  78.         accessing  what  the XMS specification refers to as "Upper Memory
  79.         Blocks"  (UMB's).   Although  described in the XMS specification,
  80.         the  UMB functions have not been implemented in the current (June
  81.         1990) and previous versions of HIMEM.SYS.  
  82.  
  83.         If  an XMS driver has not been loaded, then HIGHUMM will become a
  84.         UMB-Only  XMS  device driver, providing support for XMS functions
  85.         00h   (Get   Version  Number),  10h  (Allocate  UMB  Block),  11h
  86.         (Deallocate  UMB  Block).   All  other  XMS functions will return
  87.         failure, indicating that the function is not implemented.  
  88.  
  89.  
  90.                                 Important!       
  91.  
  92.                 If  another  XMS  device driver is used (e.g., to
  93.                 provide  management  of  Extended  Memory  or the
  94.                 High  Memory  Area),  it  must  be  loaded before
  95.                 HIGHUMM.SYS.  
  96.  
  97.  
  98.         Upper  Memory  Blocks  (UMBs)  are  blocks of memory available on
  99.         some  80x86  based  machines which are located between DOS's 640K
  100.         limit  and  the  1MB  address  boundary.   The  number, size, and
  101.         location  of these blocks vary widely depending upon the types of
  102.         hardware  adapter cards installed in the machine.  By definition,
  103.         this   memory   is  DOS-accessible,  but  does  NOT  include  the
  104.         Bank-Switch memory supported by LASTBYTE.  
  105.  
  106.         On  80286  and  80386  based machines, XMS allows DOS programs to
  107.         utilize  Extended  Memory  in  a  consistent, machine independent
  108.         manner.   With some restrictions, XMS adds almost 64K of Extended
  109.         Memory  to  the  640K  which  DOS  programs  can access directly.
  110.         Depending  on  available  hardware,  XMS  may  provide  even more
  111.         memory  (UMB's)  to DOS programs.  XMS also provides DOS programs
  112.         with a standard method of storing data in Extended Memory.  
  113.  
  114.         The   XMS  Specification  version  2.0  for  MS-DOS  was  jointly
  115.         developed  by  Lotus,  Intel,  Microsoft,  and AST Research.  The
  116.         specification  was published on July 19, 1988 and released to the
  117.  
  118.  
  119.  
  120.          Copyright (C) 1990, Key Software Products.  All Rights Reserved
  121.  
  122.  
  123.         Dec 04, 1990      HIGHUMM.SYS API Specification                 2
  124.  
  125.  
  126.         public  domain  and  is  not confidential or proprietary, but the
  127.         specification  is  still  the  copyright  and  property  of these
  128.         companies.   You  may  obtain  a copy from Microsoft Corporation,
  129.         16011  NE  36th  Way, Box 97017, Redmond, WA 98073, or by calling
  130.         Microsoft at (800) 426-9400.  
  131.  
  132.         Access to the UMB's through XMS is a four step process: 
  133.  
  134.                 1.  Test for the existence of the XMS driver.  
  135.                 2.  Obtain the address of the XMS control function.  
  136.                 3.  Invoke the Request UMB or Release UMB function.  
  137.                 4.  Check for success or failure.  
  138.  
  139.         This is best explained by an example: 
  140.  
  141.                 ...  
  142.                 mov     ax,4300h        ; XMS driver installed? 
  143.                 int     2Fh 
  144.                 cmp     al,80h 
  145.                 jne     NoXMSDriver 
  146.                 ...  
  147.                 mov     ax,4310h        ; Get adrs of XMS Ctl Func 
  148.                 int     2Fh 
  149.                 mov     WORD PTR [XMSControl],bx 
  150.                 mov     WORD PTR [XMSControl+2],es 
  151.                 ...  
  152.                 mov     ah,10h          ; Request a UMB memory block 
  153.                 mov     dx,size_in_paragraphs 
  154.                 call    [XMSControl]    ; a FAR call! 
  155.                 cmp     ax,1 
  156.                 jne     Request_Failed 
  157.  
  158.                 ; If request was successful: 
  159.                 ; -------------------------- 
  160.                 ; AX = 1 
  161.                 ; BX = Segment address of allocated block 
  162.                 ; DX = Actual size of block (same as requested size) 
  163.  
  164.                 ; If request failed: 
  165.                 ; ------------------ 
  166.                 ; AX = 0 
  167.                 ; DX = size of largest available in paragraphs 
  168.                 ; Error Codes:  BL = 80h (Not implemented/installed) 
  169.                 ;               BL = B0h (Smaller UMB available) 
  170.                 ;               BL = B1h (No UMB available) 
  171.  
  172.                 mov     ah,11h          ; Release a UMB memory block 
  173.                 mov     dx,segment_address_of_umb 
  174.                 call    [XMSControl]    ; a FAR call! 
  175.                 cmp     ax,1 
  176.                 jne     Release_Failed 
  177.  
  178.  
  179.  
  180.          Copyright (C) 1990, Key Software Products.  All Rights Reserved
  181.  
  182.  
  183.         Dec 04, 1990      HIGHUMM.SYS API Specification                 3
  184.  
  185.  
  186.  
  187.                 ; If request was successful: 
  188.                 ; -------------------------- 
  189.                 ; AX = 1 
  190.  
  191.                 ; If request failed: 
  192.                 ; ------------------ 
  193.                 ; AX = 0 
  194.                 ; Error Codes:  BL = 80h (Not implemented/installed) 
  195.                 ;               BL = B2h (invalid segment number) 
  196.  
  197.  
  198.         HIGHMEM lists such UMB memory blocks as "MS-DOS XMS UMB".  
  199.  
  200.  
  201.         _2_.__B_a_n_k_-_S_w_i_t_c_h__M_e_m_o_r_y_______ 
  202.  
  203.         The  second  method  of  accessing  high memory is by opening the
  204.         device  "KSP$UMM"  and  performing  an  IOCTL Read of four bytes.
  205.         This  obtains  the  offset and segment address of an extended UMB
  206.         control  function  that  provides access to Bank-Switch memory as
  207.         well  as  normal  UMB  blocks.   Using HIGHUMM.SYS in this manner
  208.         does  not  require  that  an  XMS  driver  such  as  HIMEM.SYS be
  209.         loaded.  For example: 
  210.  
  211.  
  212.         Device_Name     db     'KSP$UMM',0   ;  HIGHUMM.SYS  device  name
  213.         HIGHUMM_Ctl   dw   0,0         ; far ptr to ctl func 
  214.  
  215.                 ...  
  216.                 mov     ax,3D00h        ; open file or device 
  217.                 mov     dx,OFFSET Device_Name   ; DS:DX => device name 
  218.                 int     21h 
  219.                 jc      Open_Failed     ; (HIGHUMM.SYS not installed) 
  220.                 mov     handle,ax       ; save handle 
  221.  
  222.                 mov     ax,4400h        ; ioctl: get device attributes 
  223.                 mov     bx,handle 
  224.                 int     21h 
  225.                 jc      Attb_Failed     ; (HIGHUMM.SYS not functioning) 
  226.                 test    dl,80h          ; is this a device or a filename 
  227.                 jz      Not_Device      ; File called "KSP$UMM" exists! 
  228.  
  229.                 mov     ax,4402h        ; IOCTL Read (BX = handle) 
  230.                 mov     bx,handle 
  231.                 mov     dx,OFFSET HIGHUMM_Ctl   ; DS:DX => read buffer 
  232.                 mov     cx,4            ; read *EXACTLY* four bytes 
  233.                 int     21h 
  234.  
  235.                 pushf 
  236.                 mov     ah,3Eh          ; Close device (BX = handle) 
  237.  
  238.  
  239.  
  240.          Copyright (C) 1990, Key Software Products.  All Rights Reserved
  241.  
  242.  
  243.         Dec 04, 1990      HIGHUMM.SYS API Specification                 4
  244.  
  245.  
  246.                 mov     bx,handle 
  247.                 int     21h 
  248.                 popf 
  249.  
  250.                 jc      IOCTL_Error     ; (HIGHUMM.SYS not functioning) 
  251.  
  252.                 ; Offset of control function is in "HIGHUMM_Ctl" 
  253.                 ; Segment of control function is in "HIGHUMM_Ctl+2" 
  254.  
  255.  
  256.         Once  you  have the address of the extended control function from
  257.         HIGHUMM.SYS, you can invoke any of the following 13 functions: 
  258.  
  259.                 Function        Description                     Class 
  260.                 --------        -----------                     -------- 
  261.  
  262.                 AH = 0  Request a UMB memory block              STANDARD 
  263.                 AH = 1  Release a UMB memory block              STANDARD 
  264.  
  265.                 AH = 2  Request a Bank-Switch memory block      EXTRA 
  266.                 AH = 3  Release a Bank-Switch memory block      EXTRA 
  267.                 AH = 4  Transfer data to/from high memory       EXTRA 
  268.                 AH = 5  Get a Word from a Bank-Switch block     EXTRA 
  269.                 AH = 6  Put a Word to a Bank-Switch block       EXTRA 
  270.                 AH = 7  Put a Byte to a Bank-Switch block       EXTRA 
  271.                 AH = 8  Enable Bank-Switch Memory               EXTRA 
  272.                 AH = 9  Disable Bank-Switch Memory              EXTRA 
  273.                 AH = A  Assign a name to a UMB or BSW block     EXTRA 
  274.                 AH = B  Locate a UMB block by name              EXTRA 
  275.                 AH = C  Locate a BSW block by name              EXTRA 
  276.  
  277.  
  278.  
  279.         Support  for  the  "EXTRA" class of functions requires use of the
  280.         EXTRA option on the HIGHUMM.SYS command line: 
  281.  
  282.                       DEVICE=HIGHDRVR.SYS HIGHUMM.SYS EXTRA
  283.  
  284.                    ("EXTRA" may be abbreviated as simply "E".)
  285.  
  286.         These  function  numbers  are  different  than  those  used  with
  287.         XMSControl  even though the first two are otherwise equivalent to
  288.         XMS  functions 10h and 11h!  Calling one of the HIGHUMM functions
  289.         is  similar  to  calling  the  XMS  functions.   For  example, to
  290.         request  a  Bank-Switch memory block, the following code would be
  291.         used:  
  292.  
  293.                 mov     ah,2                    ; Request a BSW block 
  294.                 mov     dx,paragraphs 
  295.                 call    [HIGHUMM_Control]       ; a FAR call! 
  296.                 cmp     ax,1 
  297.  
  298.  
  299.  
  300.          Copyright (C) 1990, Key Software Products.  All Rights Reserved
  301.  
  302.  
  303.         Dec 04, 1990      HIGHUMM.SYS API Specification                 5
  304.  
  305.  
  306.                 jne     Request_Failed          ; BL contains error code 
  307.                                                 ; DX = largest available 
  308.  
  309.                 ; Success: BX contains segment number 
  310.  
  311.         For  all  HIGHUMM.SYS  functions, the error codes are the same as
  312.         returned by the XMS driver: 
  313.  
  314.                 AX = 0001h      Function successful 
  315.                      0000h      Function failed; error code in BL 
  316.  
  317.                 BL = 80h        Function not implemented 
  318.                      B0h        Insuf. memory; smaller block available 
  319.                      B1h        Insuf. memory; no block available 
  320.                      B2h        Invalid block segment number 
  321.  
  322.  
  323.         _3_.__S_u_m_m_a_r_y__o_f__H_I_G_H_U_M_M_._S_Y_S__F_u_n_c_t_i_o_n_s_____ 
  324.  
  325.  
  326.         3.1 Function 0: Request a UMB memory block  
  327.  
  328.              Parameters:     AH = 0
  329.                              DX = Size of requested block in paragraphs
  330.  
  331.              Returns:        AX = Status
  332.                              BX = Segment Number or Error Code
  333.                              DX = Size of requested block/largest block
  334.  
  335.              Description:    Identical to XMS function 10h
  336.  
  337.  
  338.         3.2 Function 1: Release a UMB memory block  
  339.  
  340.              Parameters:     AH = 1
  341.                              DX = Segment number of memory block
  342.  
  343.              Returns:        AX = Status
  344.                              BL = Error Code
  345.  
  346.              Description:    Identical to XMS function 11h
  347.  
  348.  
  349.         3.3 Function 2: Request a Bank-Switch memory block  
  350.  
  351.              Parameters:     AH = 2
  352.                              DX = Size of requested block in paragraphs
  353.  
  354.              Returns:        AX = Status
  355.                              BX = Segment Number or Error Code
  356.                              DX = Size of requested block/largest block
  357.  
  358.  
  359.  
  360.          Copyright (C) 1990, Key Software Products.  All Rights Reserved
  361.  
  362.  
  363.         Dec 04, 1990      HIGHUMM.SYS API Specification                 6
  364.  
  365.  
  366.  
  367.              Description:    Similar to function 0 for regular UMB blocks,
  368.                              except that HIGHMEM lists these blocks as
  369.                              "Bank-Switch UMB".
  370.  
  371.  
  372.         3.4 Function 3: Release a Bank-Switch memory block  
  373.  
  374.              Parameters:     AH = 3
  375.                              DX = Segment number of memory block
  376.  
  377.              Returns:        AX = Status
  378.                              BL = Error Code
  379.  
  380.              Description:    Similar to function 1 for regular UMB blocks.
  381.  
  382.  
  383.         3.5 Function 4: Transfer data to/from high memory  
  384.  
  385.              Parameters:     AH = 4
  386.                              DS:SI = Segment:Offset of source
  387.                              ES:DI = Segment:Offset of destination
  388.                              CX = byte count
  389.  
  390.              Returns:        AX = Status (Never returns failure)
  391.  
  392.              Description:    Enables Bank-Switch Memory, copies data between
  393.                              the specified source and destination, then
  394.                              disables Bank-Switch memory.
  395.  
  396.  
  397.         3.6 Function 5: Get a Word from a Bank-Switch block
  398.  
  399.              Parameters:     AH = 5
  400.                              ES:DI = Segment:Offset of word to read
  401.  
  402.              Returns:        AX = Status (Never returns failure)
  403.                              DX = WORD from BSW Block
  404.  
  405.              Description:    Enables Bank-Switch Memory, loads DX from the
  406.                              specified location, then disables Bank-Switch
  407.                              memory.
  408.  
  409.  
  410.         3.7 Function 6: Put a Word to a Bank-Switch block
  411.  
  412.              Parameters:     AH = 6
  413.                              DX = Word to put into BSW Block
  414.                              ES:DI = Segment:Offset of word to write
  415.  
  416.              Returns:        AX = Status (Never returns failure)
  417.  
  418.  
  419.  
  420.          Copyright (C) 1990, Key Software Products.  All Rights Reserved
  421.  
  422.  
  423.         Dec 04, 1990      HIGHUMM.SYS API Specification                 7
  424.  
  425.  
  426.  
  427.              Description:    Enables Bank-Switch Memory, stores DX into the
  428.                              specified location, then disables Bank-Switch
  429.                              memory.
  430.  
  431.  
  432.         3.8 Function 7: Put a Byte to a Bank-Switch block
  433.  
  434.              Parameters:     AH = 7
  435.                              DL = Byte to put into BSW Block
  436.                              ES:DI = Segment:Offset of byte to write
  437.  
  438.              Returns:        AX = Status (Never returns failure)
  439.  
  440.              Description:    Enables Bank-Switch Memory, stores DL into the
  441.                              specified location, then disables Bank-Switch
  442.                              memory.
  443.  
  444.  
  445.         3.9 Function 8: Enable Bank-Switch Memory    
  446.  
  447.              Parameters:     AH = 8
  448.                              DS:SI = Segment:Offset of 6-byte save area
  449.  
  450.              Returns:        AX = Status (Never returns failure)
  451.  
  452.              Description:    Disables interrupts, saves the memory controller
  453.                              state in a 6-byte save area within the 
  454.                              application program, and enables Bank-Switch
  455.                              memory so that data within it may be accessed.
  456.  
  457.  
  458.         3.10 Function 9: Disable Bank-Switch Memory    
  459.  
  460.              Parameters:     AH = 9
  461.                              DS:SI = Segment:Offset of 6-byte save area
  462.  
  463.              Returns:        AX = Status (Never returns failure)
  464.  
  465.              Description:    Reloads the state of the memory controller from a
  466.                              6-byte save area in the application program and
  467.                              restores the previous interrupt enable status.
  468.  
  469.  
  470.         3.11 Function 10: Assign a name to a UMB or
  471.  
  472.              Parameters:     AH = 0Ah
  473.                              DX = Segment number of memory block
  474.                              DS:SI = Segment:Offset of 8-byte blank-padded
  475.                                      name
  476.  
  477.  
  478.  
  479.  
  480.          Copyright (C) 1990, Key Software Products.  All Rights Reserved
  481.  
  482.  
  483.         Dec 04, 1990      HIGHUMM.SYS API Specification                 8
  484.  
  485.  
  486.              Returns:        AX = Status
  487.                              BX = Error Code
  488.  
  489.              Description:    Copies 8 bytes to the name field of the
  490.                              allocated UMB or BSW memory block.
  491.  
  492.  
  493.         3.12 Function 11: Locate a UMB block by name 
  494.  
  495.              Parameters:     AH = 0Bh
  496.                              DS:SI = Segment:Offset of 8-byte blank-padded
  497.                                      name
  498.  
  499.              Returns:        AX = Status
  500.                              BX = Segment Number or Error Code
  501.                              DX = Size of block
  502.  
  503.              Description:    Locates a UMB memory block by its 1-8 character
  504.                              name.  All 8 bytes of name are compared; letter
  505.                              with different case do not match.
  506.  
  507.  
  508.         3.13 Function 12: Locate a BSW block by name 
  509.  
  510.              Parameters:     AH = 0Bh
  511.                              DS:SI = Segment:Offset of 8-byte blank-padded
  512.                                      name
  513.  
  514.              Returns:        AX = Status
  515.                              BX = Segment Number or Error Code
  516.                              DX = Size of block
  517.  
  518.              Description:    Locates a BSW memory block by its 1-8 character
  519.                              name.  All 8 bytes of name are compared; letter
  520.                              with different case do not match.
  521.  
  522.         IMPORTANT!  A  call  to  function 8 must be followed by a call to
  523.         function  9, and without enabling interrupts in between.  This is
  524.         because  while  Bank-Switch  memory  is enabled, all adapter RAMs
  525.         (including  display  buffers) and any ROMs which are not shadowed
  526.         are  disabled;  thus  any  code (either your own program or a TSR
  527.         activated  by  the  timer  tick)  that  attempts  to access these
  528.         resources  will fail.  Also, it is important to execute this code
  529.         quickly  to  minimize  the  amount  of  time  that interrupts are
  530.         disabled.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.          Copyright (C) 1990, Key Software Products.  All Rights Reserved
  541.  
  542.  
  543.         Dec 04, 1990      HIGHUMM.SYS API Specification                 9
  544.  
  545.  
  546.         _4_.__F_i_n_a_l__N_o_t_e_s_______ 
  547.  
  548.         The  only valid use of Bank-Switch memory is to store data! Never
  549.         load  a program into Bank-Switch memory and then reference it via
  550.         a  JMP  or  CALL  -  it won't be there!  For example, you may NOT
  551.         load   a  TSR  into  Bank-Switch  memory  and  expect  it  to  be
  552.         accessible when it's activating interrupt occurs.  
  553.  
  554.         UMB's  (regular  and  Bank-Switched) are NOT automatically free'd
  555.         at  program  termination  like  regular  memory allocated by your
  556.         program  using  DOS  function  72 (48 hex).  For example, if your
  557.         program  uses  a  UMB for a temporary buffer, you must be sure to
  558.         release the UMB before terminating the program.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.  
  599.  
  600.          Copyright (C) 1990, Key Software Products.  All Rights Reserved
  601.  
  602.  
  603.                           HIGHUMM.SYS API Specification
  604.  
  605.  
  606.                                 Table of Contents
  607.  
  608.  
  609.         1. XMS Upper Memory Blocks     ............................    1
  610.  
  611.         2. Bank-Switch Memory       ...............................    3
  612.  
  613.         3. Summary of HIGHUMM.SYS Functions     ...................    5
  614.            3.1  Function 0: Request a UMB memory block  ...........    5
  615.            3.2  Function 1: Release a UMB memory block  ...........    5
  616.            3.3  Function 2: Request a Bank-Switch memory block  ...    5
  617.            3.4  Function 3: Release a Bank-Switch memory block  ...    6
  618.            3.5  Function 4: Transfer data to/from high memory  ....    6
  619.            3.6  Function 5: Get a Word from a Bank-Switch block....    6
  620.            3.7  Function 6: Put a Word to a Bank-Switch block......    6
  621.            3.8  Function 7: Put a Byte to a Bank-Switch block......    7
  622.            3.9  Function 8: Enable Bank-Switch Memory    ..........    7
  623.            3.10  Function 9: Disable Bank-Switch Memory    ........    7
  624.            3.11  Function 10: Assign a name to a UMB or............    7
  625.            3.12  Function 11: Locate a UMB block by name ..........    8
  626.            3.13  Function 12: Locate a BSW block by name ..........    8
  627.  
  628.         4. Final Notes       ......................................    8
  629.  
  630.  
  631.  
  632.  
  633.  
  634.  
  635.  
  636.  
  637.  
  638.  
  639.  
  640.  
  641.  
  642.  
  643.  
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.  
  660.          Copyright (C) 1990, Key Software Products.  All Rights Reserved
  661.  
  662.